Skip to content

Fix Grammar, Formatting & Terminology #1509

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 6 commits into from
Closed

Fix Grammar, Formatting & Terminology #1509

wants to merge 6 commits into from
+8 −8

Conversation

@PixelPil0t1
Copy link

Changes Summary:
.husky/pre-push → Changed "Update" → "Updated" (past tense correction).
lib/growthbook.ts → Formatting fix for better readability.
notes/content-reuse.md → "directories" → "directory" (singular), "a" → "an" (vowel sound).
nft-tools.mdx → Added "in" before "early February" (grammar fix).
oracles.mdx →
Added "for" in "random number generation" (grammar fix).
Corrected "RGN" → "RNG" (correct abbreviation).
Purpose:
Fix minor grammar, terminology, and formatting issues for clarity and correctness.

@PixelPil0t1 PixelPil0t1 requested review from a team and 0xmariniere as code owners March 17, 2025 10:29
@netlify
Copy link

netlify bot commented Mar 17, 2025 •
edited
Loading

✅ Deploy Preview for docs-optimism ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit fa91503
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/67d7f99c4b210800083b7f0a
😎 Deploy Preview https://deploy-preview-1509--docs-optimism.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 17, 2025

📝 Walkthrough

Walkthrough

The pull request consists of several minor text and formatting changes across different files. In the .husky/pre-push script, the commit message has been updated to use a past tense verb and a newline was added at the file's end. In the lib/growthbook.ts file, a trailing comma was added to an object literal passed to the GrowthBook constructor. Additionally, the wording in notes/content-reuse.md has been clarified by changing "in the content directories" to "in the content directory." Similarly, minor grammatical corrections were applied in pages/app-developers/tools/build/nft-tools.mdx and pages/app-developers/tools/build/oracles.mdx—the latter also involved updating a section title abbreviation from “RGN” to “RNG.” These changes are purely cosmetic and do not alter any functional logic.

Possibly related PRs

Suggested reviewers

  • krofax
  • sbvegan

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.
📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6aa39b0 and fa91503.

📒 Files selected for processing (5)
  • .husky/pre-push (1 hunks)
  • lib/growthbook.ts (1 hunks)
  • notes/content-reuse.md (1 hunks)
  • pages/app-developers/tools/build/nft-tools.mdx (1 hunks)
  • pages/app-developers/tools/build/oracles.mdx (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with ...

**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:

  • First, check the frontmatter section at the top of the file:
    1. For regular pages, ensure ALL these fields are present and not empty:
    ---
title: [non-empty]
lang: [non-empty]
description: [non-empty]
topic: [non-empty]
personas: [non-empty array]
categories: [non-empty array]
content_type: [valid type]
---
    1. For landing pages (index.mdx or files with ), only these fields are required:
    ---
title: [non-empty]
lang: [non-empty]
description: [non-empty]
topic: [non-empty]
---
    1. If any required fields are missing or empty, comment:
      'This file appears to be missing required metadata. You can fix this by running:
    pnpm metadata-batch-cli:dry "path/to/this/file.mdx"
    Review the changes, then run without :dry to apply them.'
  • Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
  • Avoid gender-specific language and use the imperative form.
  • Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
  • Ensure proper nouns are capitalized in sentences.
  • Apply the Oxford comma.
  • Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
  • Use correct spelling and grammar at all times (IMPORTANT).
  • For H1, H2, and H3 headers:
    1. Use sentence case, capitalizing only the first word.
    2. Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
    3. Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
  • Flag any headers that seem to inconsistently apply these rules for manual review.
  • When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
    "
  • pages/app-developers/tools/build/oracles.mdx
  • pages/app-developers/tools/build/nft-tools.mdx
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - docs-optimism
  • GitHub Check: Header rules - docs-optimism
  • GitHub Check: Pages changed - docs-optimism
🔇 Additional comments (7)
notes/content-reuse.md (1)

33-34: Grammatical Correction: Revised Text for Clarity

The change from "directories" to "directory" clearly specifies that a single content directory is expected. This minor correction improves the clarity of the instructions.

pages/app-developers/tools/build/nft-tools.mdx (1)

40-42: Grammatical Improvement in Callout

The update in the Callout component now reads "last updated in early February 2024," with the added preposition "in" enhancing the sentence flow.

lib/growthbook.ts (1)

4-7: Formatting Improvement: Consistent Trailing Comma

Adding a trailing comma after clientKey helps maintain consistent formatting and can lead to cleaner diffs in future modifications.

.husky/pre-push (1)

26-27: Grammar Correction in Commit Message

The commit message has been updated to use "Updated" instead of "Update," aligning the verb tense correctly. The addition of a newline at the end also improves file formatting.

pages/app-developers/tools/build/oracles.mdx (3)

1-2: Frontmatter Delimiter Anomaly

The frontmatter now begins with RNG--- instead of the standard ---. This unexpected prefix could affect YAML parsing in certain static site generators. Please verify if this was an intentional change.

3-6: Enhanced Description Clarity

The description now includes "for random number generation" (i.e. "onchain as well as for random number generation"), which improves grammatical accuracy and clarity.

51-52: Corrected Abbreviation in Section Header

The header now reads "Random number generation (RNG)"—correcting the previous abbreviation and ensuring consistency with standard terminology.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@opgitgovernance opgitgovernance mentioned this pull request Apr 1, 2025
Closed
@PixelPil0t1
Copy link
Author

@krofax

@sbvegan
Copy link
Collaborator

sbvegan commented Oct 28, 2025

Hey thanks for opening this PR, but we've updated our docs framework to mintlify. I apologize for the very late reply, I'll try to be more on top of PRs moving forward

@sbvegan sbvegan closed this Oct 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@0xmariniere 0xmariniere Awaiting requested review from 0xmariniere 0xmariniere is a code owner

1 more reviewer

@krofax krofax krofax approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@PixelPil0t1 @sbvegan @krofax